fix (jkube-kit/enricher) : YAML multiline annotations incorrectly serialized on windows #3014
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eclipse JKube CI ReportStarted new GH workflow run for #3014 (2024-05-06T10:20:52Z) ⚙️ JKube E2E Tests (8967299429)
|
Closed
1 task
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3014 +/- ##
=============================================
+ Coverage 59.36% 70.87% +11.51%
- Complexity 4586 5087 +501
=============================================
Files 500 490 -10
Lines 21211 19595 -1616
Branches 2830 2528 -302
=============================================
+ Hits 12591 13888 +1297
+ Misses 7370 4479 -2891
+ Partials 1250 1228 -22 ☔ View full report in Codecov by Sentry. |
manusa
reviewed
May 3, 2024
| if (value.contains(System.lineSeparator()) && !value.endsWith(System.lineSeparator())) { | ||
| return value + System.lineSeparator(); | ||
| if (containsAny(value, "\r?\n") && !value.endsWith("\n")) { | ||
| return value.replaceAll("\r?\n", "\n") + "\n"; |
There was a problem hiding this comment.
I don't get about the replaceAll call.
I think that it'd be easier if you got a matcher and then appended whatever matched (either \n or \r\n)
manusa
reviewed
May 3, 2024
Comment on lines
222
to
223
| @DisplayName("Yaml scalar with multi line values") | ||
| class YamlScalarWithMultilineString { |
There was a problem hiding this comment.
I'm not sure if scalar is the relevant part or neither what we want to test.
If it is, I guess a suitable description is Multi-line strings are serialized to YAML using scalar blocks
rohanKanojia
force-pushed
the
pr/metadata-visitor-multiline
branch
from
8fdf3cb to
c399390
Compare
manusa
reviewed
May 6, 2024
Comment on lines
118
to
125
| Matcher m = CONTAINS_LINE_BREAK.matcher(value); | ||
| String matchedLineBreak = null; | ||
| while (m.find()) { | ||
| matchedLineBreak = m.group(); | ||
| } | ||
| if (matchedLineBreak != null && !value.endsWith("\n")) { | ||
| return value.replaceAll(matchedLineBreak, "\n") + "\n"; | ||
| } | ||
| return value; |
There was a problem hiding this comment.
We probably need to discuss this again, since in our last sync this is not what we discussed.
The idea was to match a line break, and then append the match:
if (m.find()) {
String eol = m.group();
if (!value.endsWith(eol) {
return value + eol;
}
}
return value;There was a problem hiding this comment.
You're right. I tested this and it seems to make test pass. I've updated it as per your suggestion.
…ialized on windows Related to eclipse-jkube#2841 Currently for enforcing trailing newline in case of multi line strings in resource annotations, we were relying on presence of `System.lineSeparator()`. This was causing problems as YAML multiline scalar values are converted into strings with Line Feed (`\n`) endings when they're deserialized into objects. Modify logic in MetadataVisitor with respect to this behavior. Signed-off-by: Rohan Kumar <[email protected]>
rohanKanojia
force-pushed
the
pr/metadata-visitor-multiline
branch
from
c399390 to
2c0ca60
Compare
manusa
approved these changes
May 6, 2024
|
This was referenced Oct 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related to #2841
Currently for enforcing trailing newline in case of multi line strings in resource annotations, we were relying on presence of
System.lineSeparator().This was causing problems as YAML multiline scalar values are converted into strings with Line Feed (
\n) endings when they're deserialized into objects. I checked in YAML spec and found this:https://yaml.org/spec/1.2.2/#line-break-characters
Modify logic in MetadataVisitor with respect to this behavior.
With this change, kubernetes-maven-plugin/it/metadata-labels-annotations integration test is passing on Windows
Type of change
test, version modification, documentation, etc.)
Checklist